﻿//
// MouseButton.cs
//
// Copyright (C) 2018 OpenTK
//
// This software may be modified and distributed under the terms
// of the MIT license. See the LICENSE file for details.
//

namespace OpenToolkit.Windowing.Common.Input
{
    /// <summary>
    /// Enumerates all possible mouse buttons.
    /// </summary>
    public enum MouseButton
    {
        /// <summary>
        /// The left mouse button.
        /// </summary>
        Left = 0,

        /// <summary>
        /// The middle mouse button.
        /// </summary>
        Middle,

        /// <summary>
        /// The right mouse button.
        /// </summary>
        Right,

        /// <summary>
        /// The first extra mouse button.
        /// </summary>
        Button1,

        /// <summary>
        /// The second extra mouse button.
        /// </summary>
        Button2,

        /// <summary>
        /// The third extra mouse button.
        /// </summary>
        Button3,

        /// <summary>
        /// The fourth extra mouse button.
        /// </summary>
        Button4,

        /// <summary>
        /// The fifth extra mouse button.
        /// </summary>
        Button5,

        /// <summary>
        /// The sixth extra mouse button.
        /// </summary>
        Button6,

        /// <summary>
        /// The seventh extra mouse button.
        /// </summary>
        Button7,

        /// <summary>
        /// The eigth extra mouse button.
        /// </summary>
        Button8,

        /// <summary>
        /// The ninth extra mouse button.
        /// </summary>
        Button9,

        /// <summary>
        /// Indicates the last available mouse button.
        /// </summary>
        LastButton
    }
}
